﻿// ////////////////////////////////////////////////////////////////////////////
// 
// SWE Case Tool
// 
// Solution:	CaseTool
// Project:		1. CaseTool
// Filename:	MethodDescriptionAttribute.cs
// 
// File Created:	10:34 16.05.2013 
// Last Changed:	18:11 05.06.2013
// 
// ////////////////////////////////////////////////////////////////////////////

using System;

namespace SWE.CaseTool
{
	/// <summary>
	/// Contains a optional method description. If the method factory finds this
	/// attribute while parsing for possible methods, it will display the given
	/// description in the "choose method" window.
	/// </summary>
	[AttributeUsage(AttributeTargets.Class)]
	public class MethodDescriptionAttribute : Attribute
	{
		/// <summary>
		/// Initializes a new instance of the <see cref="MethodDescriptionAttribute" /> class.
		/// </summary>
		/// <param name="desc">The method descriptopn.</param>
		public MethodDescriptionAttribute(string desc) { Description = desc; }

		/// <summary>
		/// Gets or sets the method description.
		/// </summary>
		/// <value>
		/// The method description.
		/// </value>
		public string Description { set; get; }
	}
}